Skip to content

[kibana] add documentation for alert metricsets#3978

Merged
klacabane merged 1 commit intoelastic:mainfrom
klacabane:3977-kibana-readme-responseops
Aug 22, 2022
Merged

[kibana] add documentation for alert metricsets#3978
klacabane merged 1 commit intoelastic:mainfrom
klacabane:3977-kibana-readme-responseops

Conversation

@klacabane
Copy link
Copy Markdown
Contributor

@klacabane klacabane commented Aug 9, 2022

Summary

Closes #3977

Adds the standard documentation for the new metricsets introduced in elastic/beats#29899, the data streams were created in #3965

@klacabane klacabane added v8.5.0 Team:Infra Monitoring UI - DEPRECATED Label for the Infrastructure Monitoring UI team. - DEPRECATED - Use Team:obs-ux-infra_services labels Aug 9, 2022
@klacabane klacabane requested a review from a team as a code owner August 9, 2022 16:38
@klacabane
Copy link
Copy Markdown
Contributor Author

@elastic/response-ops I've added a placeholder[1] description for each metricset, could you please provide a short summary of what these metricsets are ? This documentation is publicly accessible and will show up in the Kibana Integrations UI when looking at the kibana package.

These are the new metricset that need a summary: cluster_actions cluster_rules node_actions node_rules

[1] {metricset} metrics documentation

@klacabane klacabane changed the title add documentation for alert metricsets [kibana] add documentation for alert metricsets Aug 9, 2022
@elasticmachine
Copy link
Copy Markdown

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-08-09T16:38:24.407+0000

  • Duration: 16 min 58 sec

Test stats 🧪

Test Results
Failed 0
Passed 16
Skipped 0
Total 16

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link
Copy Markdown

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (0/0) 💚
Files 100.0% (0/0) 💚 2.863
Classes 100.0% (0/0) 💚 2.863
Methods 53.846% (14/26) 👎 -35.608
Lines 100.0% (0/0) 💚 9.359
Conditionals 100.0% (0/0) 💚

Copy link
Copy Markdown
Contributor

@miltonhultgren miltonhultgren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused by how some of the docs are written, for the ECS fields we seem to be documenting what the ECS field means but also how it should be populated when implementing the spec, but doesn't isn't the integration the implementation already?

@klacabane
Copy link
Copy Markdown
Contributor Author

klacabane commented Aug 17, 2022

@miltonhultgren so this is what the type: external is for, to pull the documentation from the ecs repo (see service fields https://github.com/elastic/ecs/blob/main/schemas/service.yml#L176). It definitely is confusing, we should document each field with the specifics of the integration and not the generic description.

We can pass a description property to the fields that will override the default ecs description output to the README.

@klacabane
Copy link
Copy Markdown
Contributor Author

No updates from @elastic/response-ops, I've also notified the team in slack. Let's merge as-is and follow up with a separate PR

@klacabane klacabane merged commit aaf056f into elastic:main Aug 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team:Infra Monitoring UI - DEPRECATED Label for the Infrastructure Monitoring UI team. - DEPRECATED - Use Team:obs-ux-infra_services v8.5.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[kibana] add documentations for the actions/rules metricsets

3 participants